/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package org.erossi.pigest.model.articolo;

import java.util.HashSet;
import java.util.Set;

import org.erossi.common.model.GenericBean;
import org.erossi.common.util.AppCtx;
import org.erossi.pigest.model.documento.RigaDocumento;
import org.erossi.pigest.model.soggetto.Soggetto;
import org.erossi.pigest.model.unitamisura.UnitaMisura;

/**
 * 'Articolo' class: bean che rappresenta l'entità articolo
 *
 * @author erossi
 * @version Feb 4, 2008
 */
public class Articolo extends GenericBean {

  private static final long serialVersionUID = 1L;

  private Soggetto produttore;
  private UnitaMisura unitaMisura;
  private String nome;
  private String codiceArticoloProduttore;
  private String descrizione;
  private Set<RigaDocumento> righeDocumento;
  
  /**
   * Crea una nuova istanza della classe
   */
  public Articolo() {
    
    produttore = null;
    unitaMisura = null;
    nome = null;
    codiceArticoloProduttore = null;
    descrizione = null;
    righeDocumento = new HashSet<RigaDocumento>();
    
  }
  
  /**
   * Aggiunge una riga di documento all'insieme delle righe di documento
   *   cui questo aritoclo é associato.
   *   
   * @param rigaDocumento la riga di documento da aggiungere all'elenco
   */
  public void aggiungiRigaDocumento(RigaDocumento rigaDocumento) {
    
    righeDocumento.add(rigaDocumento);
    rigaDocumento.setArticolo(this);
    
  }
  
  /**
   * Verifica l'uguaglianza fra due oggetti.
   * 
   * <p>
   *   Nel confronto vengono verificati gli attributi significativi del bean
   *   {@link org.erossi.pigest.model.articolo.Articolo}, ovvero sono esclusi quelli che 
   *   appartengono al bean generico {@link org.erossi.common.model.GenericBean}
   *   che il primo estende.
   * </p>
   * <p>
   *   Sono esclusi dalla verifica gli attributi che costituiscono le associazioni/chiavi esterne.
   * </p>
   * <p>
   *   L'uguaglianza verificata é quindi quella <b>semantica</b>.
   * </p>
   * 
   * @param o l'oggetto di cui verificare l'uguaglianza
   */
  public boolean equals (Object o) {

    if (o == null) return false;
    if (!(o instanceof Articolo)) return false;
    if (this == o) return true;  
    
    boolean equals = false;
    
    Articolo a = (Articolo) o;
    
    if (super.nullSafeEquals(a.getNome(), this.getNome())) {
      if (super.nullSafeEquals(a.getCodiceArticoloProduttore(), this.getCodiceArticoloProduttore())) {
        if (super.nullSafeEquals(a.getDescrizione(), this.getDescrizione())) {
          equals = true;
        }
      }
    }
    
    return equals;
    
  }
  
  /**
   * Calcola l'hash per l'oggetto corrente.
   * 
   * <p>
   *   L'hash dell'oggetto é calcolato come somma degli hash dei suoi attributi,
   *   esclusi quelli che appartengono al bean generico 
   *   {@link org.erossi.common.model.GenericBean}.
   * </p>
   * <p>
   *   Sono esclusi dalla verifica gli attributi che costituiscono le associazioni/chiavi esterne.
   * </p>
   * 
   * @return l'hash corrispondente all'oggetto corrente
   */
  public int hashCode() {
    
    int hashCode = 0;
    
    if(this.getNome() != null) {hashCode += this.getNome().hashCode();}
    if(this.getCodiceArticoloProduttore() != null) {hashCode += this.getCodiceArticoloProduttore().hashCode();}
    if(this.getDescrizione() != null) {hashCode += this.getDescrizione().hashCode();}
    
    return hashCode;
   
  }
  
  /**
   * Imposta il valore dell'attributo 'righeDocumento'
   * 
   * <p>
   *   Il metodo non gestisce la biunivocità della relazione. Utilizzare il metodo
   *   {@link org.erossi.pigest.model.articolo.Articolo#aggiungiRigaDocumento(RigaDocumento)},
   *   che garantisce la corretta associazione biunivoca fra le entità.
   * </p>
   * 
   * @param righeDocumento il valore dell'attributo 'righeDocumento'
   */
  public void setRigheDocumento(Set<RigaDocumento> righeDocumento) {
    this.righeDocumento = righeDocumento;
  }
  
  /**
   * Ritorna una rappresentazione sotto forma di 
   *   stringa dell'oggetto.
   * 
   * @return una stringa che rappresenta l'oggetto
   */
  public String toString() {

    String toString = new String();
    toString = this.getClass().getName();
    
    toString += AppCtx.printDebug("super", super.toString());
    toString += AppCtx.printDebug("nome", nome);
    toString += AppCtx.printDebug("codiceArticoloProduttore", codiceArticoloProduttore);
    toString += AppCtx.printDebug("descrizione", descrizione);

    return toString;

  }

  /**
   * Restituisce il valore dell'attributo 'unitaMisura'
   * @return il valore dell'attributo unitaMisura
   */
  public UnitaMisura getUnitaMisura() {
    return this.unitaMisura;
  }

  /**
   * Imposta il valore dell'attributo 'unitaMisura'
   * @param unitaMisura il valore dell'attributo 'unitaMisura'
   */
  public void setUnitaMisura(UnitaMisura unitaMisura) {
    this.unitaMisura = unitaMisura;
  }

  /**
   * Restituisce il valore dell'attributo 'nome'
   * @return il valore dell'attributo nome
   */
  public String getNome() {
    return this.nome;
  }

  /**
   * Imposta il valore dell'attributo 'nome'
   * @param nome il valore dell'attributo 'nome'
   */
  public void setNome(String nome) {
    this.nome = nome;
  }

  
  /**
   * Restituisce il valore dell'attributo 'codiceArticoloProduttore'
   * @return il valore dell'attributo codiceArticoloProduttore
   */
  public String getCodiceArticoloProduttore() {
    return this.codiceArticoloProduttore;
  }

  /**
   * Imposta il valore dell'attributo 'codiceArticoloProduttore'
   * @param codiceArticoloProduttore il valore dell'attributo 'codiceArticoloProduttore'
   */
  public void setCodiceArticoloProduttore(String codiceArticoloProduttore) {
    this.codiceArticoloProduttore = codiceArticoloProduttore;
  }

  /**
   * Restituisce il valore dell'attributo 'descrizione'
   * @return il valore dell'attributo descrizione
   */
  public String getDescrizione() {
    return this.descrizione;
  }

  /**
   * Imposta il valore dell'attributo 'descrizione'
   * @param descrizione il valore dell'attributo 'descrizione'
   */
  public void setDescrizione(String descrizione) {
    this.descrizione = descrizione;
  }

  /**
   * Restituisce il valore dell'attributo 'produttore'
   * @return il valore dell'attributo produttore
   */
  public Soggetto getProduttore() {
    return this.produttore;
  }

  /**
   * Imposta il valore dell'attributo 'produttore'
   * @param produttore il valore dell'attributo 'produttore'
   */
  public void setProduttore(Soggetto produttore) {
    this.produttore = produttore;
  }

  /**
   * Restituisce il valore dell'attributo 'righeDocumento'
   * @return il valore dell'attributo righeDocumento
   */
  public Set<RigaDocumento> getRigheDocumento() {
    return this.righeDocumento;
  }

}

